Get Main Account Balance

Retrieves paginated balances for main accounts with optional currency, mode, and date filters.

GET https://api.spotflow.co/api/v1/balances

Headers

authorization String	Bearer SECRET_KEY Include your secret key in the request header as a Bearer token for authorization. Unauthorized requests will result in a 401 HTTP status code.

Query Parameters (Note that these are all optional)

page Integer	Indicate the specific page to retrieve.. If not provided, the first page will be returned by default.
size Integer	Indicate the number of records per page.. If unspecified, a default of 10 records will be returned.
currency String	Choose the currency you want for your sub account. According, to our currently supported currencies, this is in NGN or GHS.
mode String	According to your secret key used in the authorization i.e sk_live or sk_test, this can either be in live or test mode.
from String	This is the date of the created sub account you want to filter by in this format; 2024-08-20.
to String	This is the end of the date of the created sub accounts, you want to filter by in this format; 2024-08-27.

Sample Response:

200 OK

[
    {
        "accountNumber": "7706438396",
        "currency": "GHS",
        "balance": 3.00,
        "availableBalance": 3.00,
        "accountTag": "main-account"
    },
    {
        "accountNumber": "8450588278",
        "currency": "USD",
        "balance": 0.00,
        "availableBalance": 0.00,
        "accountTag": "main-account"
    },
    {
        "accountNumber": "5236790403",
        "currency": "NGN",
        "balance": 796.00,
        "availableBalance": 796.00,
        "accountTag": "main-account"
    }
]